

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>dscribe package &mdash; DScribe 0.2.9 documentation</title>
  

  
  
  
  

  
  <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
        <script type="text/javascript" src="../_static/jquery.js"></script>
        <script type="text/javascript" src="../_static/underscore.js"></script>
        <script type="text/javascript" src="../_static/doctools.js"></script>
        <script type="text/javascript" src="../_static/language_data.js"></script>
        <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
    
    <script type="text/javascript" src="../_static/js/theme.js"></script>

    

  
  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../_static/css/style.css" type="text/css" />
    <link rel="author" title="About these documents" href="../about.html" />
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="dscribe.core package" href="dscribe.core.html" />
    <link rel="prev" title="dscribe" href="modules.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="../index.html">
          

          
            
            <img src="../_static/logo.png" class="logo" alt="Logo"/>
          
          </a>

          
            
            
              <div class="version">
                0.2.9
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/tutorials.html">Tutorials</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">Documentation</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">dscribe package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#subpackages">Subpackages</a><ul>
<li class="toctree-l4"><a class="reference internal" href="dscribe.core.html">dscribe.core package</a></li>
<li class="toctree-l4"><a class="reference internal" href="dscribe.descriptors.html">dscribe.descriptors package</a></li>
<li class="toctree-l4"><a class="reference internal" href="dscribe.kernels.html">dscribe.kernels package</a></li>
<li class="toctree-l4"><a class="reference internal" href="dscribe.libacsf.html">dscribe.libacsf package</a></li>
<li class="toctree-l4"><a class="reference internal" href="dscribe.libmbtr.html">dscribe.libmbtr package</a></li>
<li class="toctree-l4"><a class="reference internal" href="dscribe.utils.html">dscribe.utils package</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-dscribe">Module contents</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../citing.html">Citing DScribe</a></li>
<li class="toctree-l1"><a class="reference internal" href="../about.html">About</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">DScribe</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../index.html">Docs</a> &raquo;</li>
        
          <li><a href="modules.html">dscribe</a> &raquo;</li>
        
      <li>dscribe package</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="../_sources/doc/dscribe.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="dscribe-package">
<h1>dscribe package<a class="headerlink" href="#dscribe-package" title="Permalink to this headline">¶</a></h1>
<div class="section" id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="dscribe.core.html">dscribe.core package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dscribe.core.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.core.html#module-dscribe.core.lattice">dscribe.core.lattice module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.core.html#module-dscribe.core.system">dscribe.core.system module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.core.html#module-dscribe.core">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="dscribe.descriptors.html">dscribe.descriptors package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dscribe.descriptors.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.descriptors.html#module-dscribe.descriptors.acsf">dscribe.descriptors.acsf module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.descriptors.html#module-dscribe.descriptors.coulombmatrix">dscribe.descriptors.coulombmatrix module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.descriptors.html#module-dscribe.descriptors.descriptor">dscribe.descriptors.descriptor module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.descriptors.html#module-dscribe.descriptors.elementaldistribution">dscribe.descriptors.elementaldistribution module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.descriptors.html#module-dscribe.descriptors.ewaldsummatrix">dscribe.descriptors.ewaldsummatrix module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.descriptors.html#module-dscribe.descriptors.lmbtr">dscribe.descriptors.lmbtr module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.descriptors.html#module-dscribe.descriptors.matrixdescriptor">dscribe.descriptors.matrixdescriptor module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.descriptors.html#module-dscribe.descriptors.mbtr">dscribe.descriptors.mbtr module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.descriptors.html#module-dscribe.descriptors.sinematrix">dscribe.descriptors.sinematrix module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.descriptors.html#module-dscribe.descriptors.soap">dscribe.descriptors.soap module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.descriptors.html#module-dscribe.descriptors">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="dscribe.kernels.html">dscribe.kernels package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dscribe.kernels.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.kernels.html#module-dscribe.kernels.averagekernel">dscribe.kernels.averagekernel module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.kernels.html#module-dscribe.kernels.localsimilaritykernel">dscribe.kernels.localsimilaritykernel module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.kernels.html#module-dscribe.kernels.rematchkernel">dscribe.kernels.rematchkernel module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.kernels.html#module-dscribe.kernels">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="dscribe.libacsf.html">dscribe.libacsf package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dscribe.libacsf.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.libacsf.html#module-dscribe.libacsf.acsfwrapper">dscribe.libacsf.acsfwrapper module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.libacsf.html#module-dscribe.libacsf">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="dscribe.libmbtr.html">dscribe.libmbtr package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dscribe.libmbtr.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.libmbtr.html#module-dscribe.libmbtr.mbtrwrapper">dscribe.libmbtr.mbtrwrapper module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.libmbtr.html#module-dscribe.libmbtr">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="dscribe.utils.html">dscribe.utils package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dscribe.utils.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.utils.html#module-dscribe.utils.geometry">dscribe.utils.geometry module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.utils.html#module-dscribe.utils.species">dscribe.utils.species module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.utils.html#module-dscribe.utils.stats">dscribe.utils.stats module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dscribe.utils.html#module-dscribe.utils">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="module-dscribe">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-dscribe" title="Permalink to this headline">¶</a></h2>
<p>Copyright 2019 DScribe developers</p>
<p>Licensed under the Apache License, Version 2.0 (the “License”);
you may not use this file except in compliance with the License.
You may obtain a copy of the License at</p>
<blockquote>
<div><p><a class="reference external" href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></p>
</div></blockquote>
<p>Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an “AS IS” BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.</p>
</div>
</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="dscribe.core.html" class="btn btn-neutral float-right" title="dscribe.core package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="modules.html" class="btn btn-neutral float-left" title="dscribe" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  
  <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
    <span class="rst-current-version" data-toggle="rst-current-version">
      <span class="fa fa-book"> Versions</span>
      v: 0.2.9
      <span class="fa fa-caret-down"></span>
    </span>
    <div class="rst-other-versions">
      <dl>
        <dt>Versions</dt>
        
          <dd><a href="https://singroup.github.io/dscribe/dev">0.3.0a0 (development)</a></dd>
        
          <dd><a href="https://singroup.github.io/dscribe">0.2.9 (latest stable)</a></dd>
        
      </dl>
    </div>
  </div>


  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>